List checkout sessions [V3]

curl --request GET \
  --url https://api.loops.fi/api/v3/checkout/sessions \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "checkout.session",
      "amount_subtotal": 123,
      "amount_total": 123,
      "cancel_url": "<string>",
      "currency": "<string>",
      "livemode": true,
      "mode": "payment",
      "payment_status": "paid",
      "success_url": "<string>",
      "url": "<string>",
      "automatic_tax": {
        "enabled": true,
        "status": "complete"
      },
      "billing_address_collection": "auto",
      "client_reference_id": "<string>",
      "customer": "<string>",
      "customer_email": "[email protected]",
      "expires_at": 123,
      "locale": "<string>",
      "metadata": {},
      "payment_intent": "<string>",
      "payment_method_types": [
        "<string>"
      ],
      "setup_intent": "<string>",
      "shipping": {
        "address": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "name": "<string>",
        "phone": "<string>"
      },
      "submit_type": "auto",
      "total_details": {
        "amount_discount": 123,
        "amount_shipping": 123,
        "amount_tax": 123
      },
      "productName": "<string>",
      "externalCustomerId": "<string>"
    }
  ],
  "has_more": true,
  "url": "<string>"
}

GET

api

checkout

sessions

List checkout sessions [V3]

curl --request GET \
  --url https://api.loops.fi/api/v3/checkout/sessions \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "checkout.session",
      "amount_subtotal": 123,
      "amount_total": 123,
      "cancel_url": "<string>",
      "currency": "<string>",
      "livemode": true,
      "mode": "payment",
      "payment_status": "paid",
      "success_url": "<string>",
      "url": "<string>",
      "automatic_tax": {
        "enabled": true,
        "status": "complete"
      },
      "billing_address_collection": "auto",
      "client_reference_id": "<string>",
      "customer": "<string>",
      "customer_email": "[email protected]",
      "expires_at": 123,
      "locale": "<string>",
      "metadata": {},
      "payment_intent": "<string>",
      "payment_method_types": [
        "<string>"
      ],
      "setup_intent": "<string>",
      "shipping": {
        "address": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "name": "<string>",
        "phone": "<string>"
      },
      "submit_type": "auto",
      "total_details": {
        "amount_discount": 123,
        "amount_shipping": 123,
        "amount_tax": 123
      },
      "productName": "<string>",
      "externalCustomerId": "<string>"
    }
  ],
  "has_more": true,
  "url": "<string>"
}

Authorizations

Authorization

string

header

required

API Key authentication using Bearer token

Query Parameters

status

enum<string>

Filter by session status

Available options:

PENDING,

COMPLETED,

EXPIRED,

CANCELLED

limit

number

default:10

Number of sessions to return

Required range: 1 <= x <= 100

starting_after

string

Cursor for pagination

Response

Default Response

object

enum<string>

required

String representing the object's type

Available options:

list

data

object[]

required

An array of objects

Show child attributes

data.id

string

required

Unique identifier for the object

data.object

enum<string>

required

String representing the object's type

Available options:

checkout.session

data.amount_subtotal

integer

required

Total of all items before discounts or taxes

data.amount_total

integer

required

Total of all items after discounts and taxes

data.cancel_url

string<uri>

required

The URL the customer will be directed to if they decide to cancel payment

data.currency

string

required

Three-letter ISO currency code

data.livemode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode

data.mode

enum<string>

required

The mode of the Checkout Session

Available options:

payment,

subscription,

setup

data.payment_status

enum<string>

required

Payment status

Available options:

paid,

unpaid,

no_payment_required

data.success_url

string<uri>

required

The URL the customer will be directed to after the payment or subscription creation is successful

data.url

string<uri>

required

The URL to the Checkout Session

data.automatic_tax

object

Show child attributes

data.automatic_tax.enabled

boolean

data.automatic_tax.status

enum<string>

Available options:

complete,

failed,

requires_location_inputs

data.billing_address_collection

enum<string>

Available options:

auto,

required

data.client_reference_id

string

A unique string to reference the Checkout Session

data.customer

string

ID of the customer

data.customer_email

string<email>

Email of the customer

data.expires_at

integer

Unix timestamp representing the time at which the Checkout Session expires

data.locale

string

The IETF language tag of the locale

data.metadata

object

Set of key-value pairs that you can attach to an object

data.payment_intent

string

ID of the PaymentIntent

data.payment_method_types

string[]

The list of payment method types (e.g. card) that this Checkout Session is allowed to accept

data.setup_intent

string

ID of the SetupIntent

data.shipping

object

Show child attributes

data.shipping.address

object

Show child attributes

data.shipping.address.city

string

data.shipping.address.country

string

data.shipping.address.line1

string

data.shipping.address.line2

string

data.shipping.address.postal_code

string

data.shipping.address.state

string

data.shipping.name

string

data.shipping.phone

string

data.submit_type

enum<string>

Describes the type of transaction being performed

Available options:

auto,

book,

donate,

pay

data.total_details

object

Show child attributes

data.total_details.amount_discount

integer

data.total_details.amount_shipping

integer

data.total_details.amount_tax

integer

data.productName

string

Name of the product (Loops-specific)

data.externalCustomerId

string

External customer identifier (Loops-specific)

has_more

boolean

required

Whether there are more objects available after this set

url

string

The URL to access this list

Delete a checkout session [V2]

Create a checkout session [V3]

⌘I

Getting Started

Guides

SDK

API Reference

Changelog

List checkout sessions [V3]

Authorizations

Query Parameters

Response